Skip to main content

MongoDB API

Summary​

This document covers the information to gather from MongoDB Atlas in order to configure a Qarbine data service. The data service will use the Qarbine MongoDB driver. You can define multiple data services that access the same Atlas endpoint though with varying credentials. Once a data service is defined, you can manage which Qarbine principals have access to it and its associated Atlas data. A Qarbine administrator has visibility to all data services.

Overview​

The MongoDB API is a NoSQL API popularized by its namesake MongoDB Corporation. MongoDB is a popular document oriented data server. Its database as a service offering is MongoDB™ Atlas. For details see www.mongodb.com.

Other database vendors have implemented subsets of the MongoDB API in their offerings such as Microsoft CosmosDB for MongoDB vCore, AWS DocumentDB (with MongoDB compatibility), and Singlestore Kai.

In general Qarbine’s interface relies on a “connection string” to an MongoDB API endpoint with subsequent behavior consistency varying by non MongoDB Corporation vendor.

MongoDB API Configuration​

Overview​

Qarbine compute nodes perform the data queries against MongoDB API data servers. Customers can choose to deploy Qarbine compute nodes in a large variety of manners. As such network port and IP access rules have to be verified to be secure and appropriate.

In general the core setting required is the MongoDB “connection string”. Detailed information can be found at https://www.mongodb.com/docs/manual/reference/connection-string/

It is recommended that only read-only accounts be used in the connection strings setup in Qarbine Data Services.

Self-hosted Considerations​

When hosting in a cloud vendor such as AWS, the Qarbine compute node must have port accessibility to the primary MongoDB server.

DBaaS Considerations​

MongoDB Atlas and some other services provide IP access rules along with various other options. The Qarbine compute node’s IP address must be allowed access at the network and account level in some manner so that queries can be run from Qarbine compute nodes.

MongoDB Data Lake™ Considerations​

Use the following options so that some interaction nuances are taken care of mainly in the area of index information access.

  

Qarbine Data Service Configuration​

Overview​

The Qarbine data service requires:

  • Qarbine compute node URL,
  • MongoDB connection string, and
  • Default database.

Defining the Qarbine Data Service​

Within the Qarbine Administration tool navigate to Data Services

  

Click

  

Enter the name, description, and compute node endpoint URL.

Choose

  

Several Data Options can be set. If the connection string refers to a MongoDB Atlas Data Lake then include the following

mongoDbDataLake=true

Set the default database in the field as shown below.

  

After you have entered the above information save the data service by clicking   .

Next, test the settings by clicking on the icon noted below.

  

You should see the following general dialog

  

Troubleshooting​

If you see something like

  

then

  • verify the compute node at thatURL is operating.
  • verify port access.
  • verify account credentials.